Arrow Resilience Kit/[root]/SlidingWindowRateLimiter

SlidingWindowRateLimiter

JS/TS-friendly facade over com.sorinirmies.arrow.resiliencekit.SlidingWindowRateLimiter.

import { SlidingWindowRateLimiter } from "arrow-resilience-kit";

const sw = await SlidingWindowRateLimiter.create({ maxRequests: 100, windowDurationMillis: 60_000 });
const result = await sw.execute(() => api.request());

Types

Companion

object Companion

Functions

currentRequests

fun currentRequests(): Promise<Int>

Current number of requests counted within the window.

execute

fun <T> execute(block: () -> Promise<T>): Promise<T>

Executes block if within the window's limit; rejects otherwise.

reset

fun reset(): Promise<Unit>

Resets the window and clears statistics.

statistics

fun statistics(): Promise<SlidingWindowStatistics>

Current statistics snapshot.

tryAcquire

fun tryAcquire(): Promise<Boolean>

Tries to acquire a slot without executing anything. Resolves true if acquired.

tryExecute

fun <T> tryExecute(block: () -> Promise<T>): Promise<T?>

Executes block only if a slot is immediately available, resolving null otherwise.